Standardize UUID validation across all REST API controllers#4591
Open
m4cd4r4 wants to merge 1 commit intoOpenFn:mainfrom
Open
Standardize UUID validation across all REST API controllers#4591m4cd4r4 wants to merge 1 commit intoOpenFn:mainfrom
m4cd4r4 wants to merge 1 commit intoOpenFn:mainfrom
Conversation
Extract a shared validate_uuid/1 function into LightningWeb.API.Helpers using the existing Ecto.UUID.dump/1 pattern. Replace private duplicate implementations in WorkflowsController and CredentialController. Apply validation to all controllers that accept UUID path or query params, so malformed UUIDs return 400 instead of raising Ecto.Query.CastError (500). Closes OpenFn#4588
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #4588.
Malformed UUID path/query params currently reach
Repo.getand raiseEcto.Query.CastError, which Phoenix turns into a 500 response. This extracts a sharedvalidate_uuid/1helper and applies it consistently across all REST API controllers.Changes:
validate_uuid/1toLightningWeb.API.Helpers- returns:okor{:error, :bad_request}WorkflowsController- privatevalidate_uuid/1now delegates to the shared helper (preserves existing 422 message behaviour viamaybe_handle_error)CredentialController- replaces privatevalidate_uuid/1with shared helper; malformed credentialidnow returns 400 instead of 404JobController,ProjectController,RunController,WorkOrdersController,ProvisioningController,AiAssistantController- addvalidate_uuid/1calls before any DB lookup that would otherwise raiseEcto.Query.CastErrorTests: UUID validation test cases added to all affected controller test files.
AI disclosure
Test plan
not-a-uuidinputsmix test test/lightning_web/controllers/api/passes